/*
 *  Copyright 2011 yura.
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */

package org.opu.vcforms.template.util;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * Load and store implemented object.
 * @author yura
 */
public interface Loadable {
    /**
     * If implemened class storing data as xml it must store this data in this
     * charset: UTF-8.
     */
    public static final String CHARSET = "UTF-8";

    /**
     * If implemened class storing data as xml it must store this data with this
     * document description:{@code "<?xml version=\"1.0\" encoding=\"utf-8\"?>"}
     */
    public static final String FORMAT_STR = "<?xml version=\"1.0\" encoding=\"utf-8\"?>";

    /**
     * Load implemented object from input stream
     * @param inputStream input stream where from object is load
     * @throws IOException if an I/O error has occurred
     */
    public void load(InputStream inputStream) throws IOException;

    /**
     * Store implemented object to output stream
     * @param outputStream output stream were to object is strore
     * @throws IOException if an I/O error has occurred
     */
    public void store(OutputStream outputStream) throws IOException;
}
